Backup Keywords and Paths

Backup and Restore > Backups and Service Types > Backup Keywords and Paths

Backup Keywords and Paths

Configure the following keywords with a valid parameter in each service configuration file to enable automatic backup for the selected service.

Keyword	Description
BACKUP_PATH	Specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.
BACKUP_TIME	Specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.
COPY_BACKUP_TO	Enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

See Service Configuration Keywords for configuration keyword defaults and options.

Backup Folder Paths

CygNet Software recommends that the backup folder be on a different physical drive on the host server than the CygNet services for two reasons:

If the backup is targeted to the same drive on which the services reside and the drive crashes, the backup data would be lost along with the live data.
If the backup is targeted to a network drive and the network connection is lost, the backup will fail.

If you are running the CygNet services as operating system services under the Local System Account, the BACKUP_PATH and COPY_BACKUP_TO parameters must use the Universal Naming Convention (UNC) (\\Workstation\Path) to identify the network paths.

If running the CygNet services as processes, you have the option of using a mapped drive identifier.

BACKUP_TIME defines the backup start time. The amount of time required to complete a backup depends upon the size of the database. Generally the backup times are staggered to improve performance (vs. attempting to backup all of the files at the same time). If the keyword is omitted, no automatic backup will occur.